Remove infinite snapshot logging #137821
Open
Remove infinite snapshot logging #137821
+238
−79
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Modifies the SnapshotShutdownProgressTracker to only log the periodic progress report when there are still snapshots left to process. This removes the existing behaviour where the report will log indefinitely, even once all snapshots are completed or paused. Closes: ES-12794
…ng-stops-when-no-snapshots
joshua-adams-1
commented
Nov 10, 2025
| // Simulate starting shutdown -- should reset the completion stats and start logging | ||
| // Register each snapshot as in progress | ||
| for (int i = 0; i < 5; ++i) { | ||
| tracker.incNumberOfShardSnapshotsInProgress(dummyShardId, dummySnapshot); |
Contributor
Author
There was a problem hiding this comment.
This mimics production behaviour where snapshots are added to the tracker prior to the node shutting down. If I didn't, when calling tracker.onClusterStateAddShutdown(); the periodic logger would begin and then immediately end since there would be no in-progress snapshots
elasticsearchmachine
added
the
needs:triage
DiannaHohensee
added
:Distributed Coordination/Snapshot/Restore
elasticsearchmachine
removed
the
needs:triage
Collaborator
|
Pinging @elastic/es-distributed-coordination (Team:Distributed Coordination) |
Contributor
DiannaHohensee
left a comment
DiannaHohensee
left a comment
There was a problem hiding this comment.
Quite a few nits, but superficial stuff.
Comments are great to have, but they should explain why something is happening, not only say what’s happening. ‘What’ can generally be understood with some effort from reading the code, but ‘why’ is the difficult part for new readers to grasp. I’d use ‘what’ comments for high level what’s happening in a section of code, when there's a series of steps. But having the ‘what’ without a clear ‘why’ is often frustrating for a reader. E.g., “I wrote this thing and this is what it does, but for the life of me I can’t remember why I wrote it to do that thing”, becomes a problem.
server/src/main/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTracker.java
Outdated
Show resolved
Hide resolved
server/src/main/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTracker.java
Outdated
Show resolved
Hide resolved
server/src/main/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTracker.java
Show resolved
Hide resolved
server/src/main/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTracker.java
Show resolved
Hide resolved
server/src/test/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTrackerTests.java
Outdated
Show resolved
Hide resolved
server/src/test/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTrackerTests.java
Outdated
Show resolved
Hide resolved
server/src/test/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTrackerTests.java
Outdated
Show resolved
Hide resolved
server/src/test/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTrackerTests.java
Outdated
Show resolved
Hide resolved
server/src/test/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTrackerTests.java
Outdated
Show resolved
Hide resolved
server/src/test/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTrackerTests.java
Outdated
Show resolved
Hide resolved
…en-no-snapshots' of https://github.com/joshua-adams-1/elasticsearch into snapshot-logging-improvements-periodic-logging-stops-when-no-snapshots
Contributor
Author
|
Hey, thank you for reviewing. I've updated in line with the comments, let me know if there's anything else you want me to clarify / improve |
server/src/test/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTrackerTests.java
Outdated
Show resolved
Hide resolved
server/src/test/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTrackerTests.java
Outdated
Show resolved
Hide resolved
server/src/test/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTrackerTests.java
Outdated
Show resolved
Hide resolved
server/src/test/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTrackerTests.java
Outdated
Show resolved
Hide resolved
server/src/test/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTrackerTests.java
Outdated
Show resolved
Hide resolved
server/src/test/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTrackerTests.java
Outdated
Show resolved
Hide resolved
server/src/main/java/org/elasticsearch/snapshots/SnapshotShutdownProgressTracker.java
Outdated
Show resolved
Hide resolved
…ng-stops-when-no-snapshots
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Modifies the
SnapshotShutdownProgressTrackerto only log the periodic progress report while there are still snapshots left to process. This removes the existing behaviour where the report will log indefinitely, even once all snapshots are completed or paused.Closes: ES-12794